/
Histogram`1.xml
307 lines (304 loc) · 20.6 KB
/
Histogram`1.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
<Type Name="Histogram<T>" FullName="System.Diagnostics.Metrics.Histogram<T>">
<TypeSignature Language="C#" Value="public sealed class Histogram<T> : System.Diagnostics.Metrics.Instrument<T> where T : struct" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit Histogram`1<struct .ctor (class System.ValueType) T> extends System.Diagnostics.Metrics.Instrument`1<!T>" />
<TypeSignature Language="DocId" Value="T:System.Diagnostics.Metrics.Histogram`1" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class Histogram(Of T)
Inherits Instrument(Of T)" />
<TypeSignature Language="F#" Value="type Histogram<'T (requires 'T : struct)> = class
 inherit Instrument<'T (requires 'T : struct)>" />
<TypeSignature Language="C++ CLI" Value="generic <typename T>
 where T : value classpublic ref class Histogram sealed : System::Diagnostics::Metrics::Instrument<T>" />
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="T">
<Constraints>
<ParameterAttribute>DefaultConstructorConstraint</ParameterAttribute>
<ParameterAttribute>NotNullableValueTypeConstraint</ParameterAttribute>
<BaseTypeName>System.ValueType</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Base>
<BaseTypeName>System.Diagnostics.Metrics.Instrument<T></BaseTypeName>
<BaseTypeArguments>
<BaseTypeArgument TypeParamName="T">T</BaseTypeArgument>
</BaseTypeArguments>
</Base>
<Interfaces />
<Docs>
<typeparam name="T">The type that the histogram represents.</typeparam>
<summary>Represents a metrics instrument that can be used to report arbitrary values that are likely to be statistically meaningful, for example, the request duration. Call <see cref="M:System.Diagnostics.Metrics.Meter.CreateHistogram``1(System.String,System.String,System.String)" /> to create a Histogram object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This class supports only the following generic parameter types: <xref:System.Byte>, <xref:System.Int16>, <xref:System.Int32>, <xref:System.Int64>, <xref:System.Single>, <xref:System.Double>, and <xref:System.Decimal>.
]]></format>
</remarks>
<related type="Article" href="/dotnet/core/diagnostics/metrics-instrumentation">Creating metrics</related>
</Docs>
<Members>
<Member MemberName="Record">
<MemberSignature Language="C#" Value="public void Record (T value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Record(!T value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Metrics.Histogram`1.Record(`0)" />
<MemberSignature Language="VB.NET" Value="Public Sub Record (value As T)" />
<MemberSignature Language="F#" Value="member this.Record : 'T -> unit" Usage="histogram.Record value" />
<MemberSignature Language="C++ CLI" Value="public:
 void Record(T value);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="T" />
</Parameters>
<Docs>
<param name="value">The measurement value.</param>
<summary>Records a measurement value.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Record">
<MemberSignature Language="C#" Value="public void Record (T value, System.Collections.Generic.KeyValuePair<string,object?> tag);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Record(!T value, valuetype System.Collections.Generic.KeyValuePair`2<string, object> tag) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Metrics.Histogram`1.Record(`0,System.Collections.Generic.KeyValuePair{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Sub Record (value As T, tag As KeyValuePair(Of String, Object))" />
<MemberSignature Language="F#" Value="member this.Record : 'T * System.Collections.Generic.KeyValuePair<string, obj> -> unit" Usage="histogram.Record (value, tag)" />
<MemberSignature Language="C++ CLI" Value="public:
 void Record(T value, System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^> tag);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="T" />
<Parameter Name="tag" Type="System.Collections.Generic.KeyValuePair<System.String,System.Object>">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 2 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 2 })>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="value">The measurement value.</param>
<param name="tag">A key-value pair tag associated with the measurement.</param>
<summary>Records a measurement value.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Record">
<MemberSignature Language="C#" Value="public void Record (T value, params System.Collections.Generic.KeyValuePair<string,object>[] tags);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Record(!T value, valuetype System.Collections.Generic.KeyValuePair`2<string, object>[] tags) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Metrics.Histogram`1.Record(`0,System.Collections.Generic.KeyValuePair{System.String,System.Object}[])" />
<MemberSignature Language="VB.NET" Value="Public Sub Record (value As T, ParamArray tags As KeyValuePair(Of String, Object)())" />
<MemberSignature Language="F#" Value="member this.Record : 'T * System.Collections.Generic.KeyValuePair<string, obj>[] -> unit" Usage="histogram.Record (value, tags)" />
<MemberSignature Language="C++ CLI" Value="public:
 void Record(T value, ... cli::array <System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^>> ^ tags);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="T" />
<Parameter Name="tags" Type="System.Collections.Generic.KeyValuePair<System.String,System.Object>[]">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[<System.ParamArray>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0, 1, 2 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 1, 0, 1, 2 })>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="value">The measurement value.</param>
<param name="tags">A list of key-value pair tags associated with the measurement.</param>
<summary>Records a measurement value.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Record">
<MemberSignature Language="C#" Value="public void Record (T value, in System.Diagnostics.TagList tagList);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Record(!T value, [in]valuetype System.Diagnostics.TagList& tagList) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Metrics.Histogram`1.Record(`0,System.Diagnostics.TagList@)" />
<MemberSignature Language="VB.NET" Value="Public Sub Record (value As T, ByRef tagList As TagList)" />
<MemberSignature Language="F#" Value="member this.Record : 'T * TagList -> unit" Usage="histogram.Record (value, tagList)" />
<MemberSignature Language="C++ CLI" Value="public:
 void Record(T value, System::Diagnostics::TagList % tagList);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="T" />
<Parameter Name="tagList" Type="System.Diagnostics.TagList" RefType="ref">
<Attributes>
<Attribute FrameworkAlternate="net-6.0;net-7.0;net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.IsReadOnly]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.IsReadOnly>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="value">The measurement value.</param>
<param name="tagList">The tags associated with the measurement.</param>
<summary>Records a measurement value.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Record">
<MemberSignature Language="C#" Value="public void Record (T value, ReadOnlySpan<System.Collections.Generic.KeyValuePair<string,object?>> tags);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Record(!T value, valuetype System.ReadOnlySpan`1<valuetype System.Collections.Generic.KeyValuePair`2<string, object>> tags) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Metrics.Histogram`1.Record(`0,System.ReadOnlySpan{System.Collections.Generic.KeyValuePair{System.String,System.Object}})" />
<MemberSignature Language="VB.NET" Value="Public Sub Record (value As T, tags As ReadOnlySpan(Of KeyValuePair(Of String, Object)))" />
<MemberSignature Language="F#" Value="member this.Record : 'T * ReadOnlySpan<System.Collections.Generic.KeyValuePair<string, obj>> -> unit" Usage="histogram.Record (value, tags)" />
<MemberSignature Language="C++ CLI" Value="public:
 void Record(T value, ReadOnlySpan<System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^>> tags);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="T" />
<Parameter Name="tags" Type="System.ReadOnlySpan<System.Collections.Generic.KeyValuePair<System.String,System.Object>>">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 0, 1, 2 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 0, 1, 2 })>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="value">The measurement value.</param>
<param name="tags">A span of key-value pair tags associated with the measurement.</param>
<summary>Records a measurement value.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Record">
<MemberSignature Language="C#" Value="public void Record (T value, System.Collections.Generic.KeyValuePair<string,object?> tag1, System.Collections.Generic.KeyValuePair<string,object?> tag2);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Record(!T value, valuetype System.Collections.Generic.KeyValuePair`2<string, object> tag1, valuetype System.Collections.Generic.KeyValuePair`2<string, object> tag2) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Metrics.Histogram`1.Record(`0,System.Collections.Generic.KeyValuePair{System.String,System.Object},System.Collections.Generic.KeyValuePair{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Sub Record (value As T, tag1 As KeyValuePair(Of String, Object), tag2 As KeyValuePair(Of String, Object))" />
<MemberSignature Language="F#" Value="member this.Record : 'T * System.Collections.Generic.KeyValuePair<string, obj> * System.Collections.Generic.KeyValuePair<string, obj> -> unit" Usage="histogram.Record (value, tag1, tag2)" />
<MemberSignature Language="C++ CLI" Value="public:
 void Record(T value, System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^> tag1, System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^> tag2);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="T" />
<Parameter Name="tag1" Type="System.Collections.Generic.KeyValuePair<System.String,System.Object>">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 2 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 2 })>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="tag2" Type="System.Collections.Generic.KeyValuePair<System.String,System.Object>">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 2 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 2 })>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="value">The measurement value.</param>
<param name="tag1">A first key-value pair tag associated with the measurement.</param>
<param name="tag2">A second key-value pair tag associated with the measurement.</param>
<summary>Records a measurement value.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Record">
<MemberSignature Language="C#" Value="public void Record (T value, System.Collections.Generic.KeyValuePair<string,object?> tag1, System.Collections.Generic.KeyValuePair<string,object?> tag2, System.Collections.Generic.KeyValuePair<string,object?> tag3);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Record(!T value, valuetype System.Collections.Generic.KeyValuePair`2<string, object> tag1, valuetype System.Collections.Generic.KeyValuePair`2<string, object> tag2, valuetype System.Collections.Generic.KeyValuePair`2<string, object> tag3) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Metrics.Histogram`1.Record(`0,System.Collections.Generic.KeyValuePair{System.String,System.Object},System.Collections.Generic.KeyValuePair{System.String,System.Object},System.Collections.Generic.KeyValuePair{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Sub Record (value As T, tag1 As KeyValuePair(Of String, Object), tag2 As KeyValuePair(Of String, Object), tag3 As KeyValuePair(Of String, Object))" />
<MemberSignature Language="F#" Value="member this.Record : 'T * System.Collections.Generic.KeyValuePair<string, obj> * System.Collections.Generic.KeyValuePair<string, obj> * System.Collections.Generic.KeyValuePair<string, obj> -> unit" Usage="histogram.Record (value, tag1, tag2, tag3)" />
<MemberSignature Language="C++ CLI" Value="public:
 void Record(T value, System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^> tag1, System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^> tag2, System::Collections::Generic::KeyValuePair<System::String ^, System::Object ^> tag3);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Diagnostics.DiagnosticSource</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="T" />
<Parameter Name="tag1" Type="System.Collections.Generic.KeyValuePair<System.String,System.Object>">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 2 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 2 })>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="tag2" Type="System.Collections.Generic.KeyValuePair<System.String,System.Object>">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 2 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 2 })>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
<Parameter Name="tag3" Type="System.Collections.Generic.KeyValuePair<System.String,System.Object>">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 2 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1, 2 })>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="value">The measurement value.</param>
<param name="tag1">A first key-value pair tag associated with the measurement.</param>
<param name="tag2">A second key-value pair tag associated with the measurement.</param>
<param name="tag3">A third key-value pair tag associated with the measurement.</param>
<summary>Records a measurement value.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>